ng911ok.tools._doc module#
Module that contains docutils-dependent code for
_Documentable subclasses.
Important
This module should only ever be imported locally inside functions or
methods, because docutils is not installed by default in the
arcgispro-py3 environment.
- class ArcDocTranslator(document)#
Bases:
HTMLTranslator- starttag(node, tagname, suffix='\n', empty=False, **attributes)#
Construct and return a start tag given a node (id & class attributes are extracted), tag name, and optional attributes.
- class SummaryDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)#
Bases:
Directive- run()#
- final_argument_whitespace = True#
May the final argument contain whitespace?
- has_content = True#
May the directive have content?
- optional_arguments = 0#
Number of optional arguments after the required arguments.
- required_arguments = 0#
Number of required directive arguments.
- class ToolDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)#
Bases:
Directive- run()#
- final_argument_whitespace = True#
May the final argument contain whitespace?
- has_content = True#
May the directive have content?
- optional_arguments = 0#
Number of optional arguments after the required arguments.
- required_arguments = 1#
Number of required directive arguments.
- _register(name: str) Callable[[type[Directive]], type[Directive]]#
- print_rst(text: str)#